接口管理
1.对外接口
- 1.项目列表-项目发布操作
| 说明 | 参数 |
|---|---|
| 请求地址 | - |
| 调用方式 | 实时 |
| 请求方式 | GET |
| 数据格式 | JSON |
| 传递参数 | - |
| 返回值 | - |
- 2.项目成员增删改拥有该项目的SVN权限
| 说明 | 参数 |
|---|---|
| 请求地址 | 仓库地址 |
| 调用方式 | 实时 |
| 请求方式 | POST |
| 数据格式 | JSON |
| 传递参数 | svn_name:仓库名,user_name:用户名 |
| 返回值 | - |
2.对内接口(API接口管理)
对项目的对外服务的基础功能的设置及监控
注:接口数据为实时数据,根据业务需求可做缓存处理,来提高调用系统的请求效率
| 操作 | 操作名称 |
|---|---|
| 请求地址 | 接口请求地址 |
| 调用方式 | 实时、ssi |
| 缓存方式 | 静态化、redis缓存、 |
| 缓存机制 | 定时任务(执行时间按照业务要求设置) |
| 缓存索引 | 根据业务需求进行设置 |
3.接口规范
3.1获取数据
- 数据为以下格式: {"code":"0000","message":"NO","data":{…}} 【注解:code状态码 0000为正确,其它情况均为有误; message错误信息,NO为无错误,其它为错误描述; data请求数据,具体数据】
3.2提交数据
- 数据提交,基于HTTP/HTTPS协议自定义JSON数据结构,采用认证的方式提交
1)数据提交格式 { "user":"test", "time":1451454697, "data":{user_id:1,...}, "checkcode":"63fb7a6c210512abf7cfa68b8995fa0d" } user接口请求分类,调用系统与接口约束好即可 time请求时间 data提交数据 checkcode加密串 2)认证机制
规范:md5($this->sUserName . md5($this->sLinkCode) . (time() / 10))
checkcode加密串:将请求类别(user)再加连接码(约定好)的md5串再加请求时间戳对10取模,将整个字符串md5加密
3)反回处理结果 {"code":"0000","message":"\u6210\u529f\u4e3e\u62a5\u95ee\u9898","data":""} 【code状态码,0000为正确,其它情况均为有误; message错误信息,NO为无错误,其它为错误描述; data为空,可忽略】